Skip to content

docs: restructure IA around product lines (Phase 1)#319

Open
shirgoldbird wants to merge 2 commits intomainfrom
restructure-docs-ia-v2
Open

docs: restructure IA around product lines (Phase 1)#319
shirgoldbird wants to merge 2 commits intomainfrom
restructure-docs-ia-v2

Conversation

@shirgoldbird
Copy link
Copy Markdown
Member

Summary

Implements Phase 1 of the docs IA proposal: reorganize the Documentation and API Reference tabs around product lines.

This is a nav-only change — no files are moved, no content is rewritten. All pages stay at their current URLs. Only docs.json navigation structure changes, plus 3 title renames.

Documentation tab

Dissolved: Essentials, Learning & How-Tos, Best Practices, XML and HTML Handling, Resources

New structure: Getting Started, Languages, Translate (with Text Translation and XML & HTML groups), Customizations, Admin, Going to Production, Cookbooks, Developer Tools, API Updates

API Reference tab

Dissolved: single flat "API Reference" group

New structure: 6 product-line groups — Translate API, Voice API, Write API, Customizations API, Admin API, Languages

Other changes

  • Navbar: replaced "DeepL Web Translator" with "API Pricing" and "Manage Keys" links
  • Title renames: "Client libraries" → "SDKs", "Test your API requests with Postman" → "Postman", "Roadmap and release notes" → "Changelog"
  • Pages hidden from nav (files still exist for Phase 2 merges): About, DeepL 101, Authentication, Client libraries reference, Cookbook overview

What this does NOT change

  • No files moved (URLs unchanged, no redirects needed)
  • No content rewrites (Phase 2)
  • No new pages created (Phase 3)
  • Voice and Write sections in Documentation tab deferred until overview pages exist

Test plan

  • Verify Mintlify preview deploys successfully
  • Spot-check Documentation tab nav matches target IA
  • Spot-check API Reference tab has 6 product-line groups
  • Verify navbar shows API Pricing and Manage Keys links
  • Verify SDKs, Postman, and Changelog titles render correctly
  • Check DEPRECATED tag on Glossaries v2 group
  • Check BETA tag on Detect Language and v3 Languages groups
  • Confirm hidden pages (About, Auth, DeepL 101) don't appear in sidebar

🤖 Generated with Claude Code

Reorganize Documentation and API Reference tabs around product lines.
Four sections dissolved (Best Practices, Learning & How-Tos, XML and
HTML Handling, Resources). New sections: Translate, Voice, Write,
Customizations, Admin, Going to Production, Cookbooks, Developer Tools,
Languages, API Updates.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 24, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
deepl-c950b784 🟢 Ready View Preview Apr 24, 2026, 1:37 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

…te in API ref

- Detect Language and Quality Estimation are single pages, not groups
- Glossaries, Style Rules, and Translation Memory nested under Translate API
  in API Reference (not a separate Customizations API group)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@shirgoldbird shirgoldbird marked this pull request as ready for review April 24, 2026 01:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant